JAMS REST API Web Service
GetJob_GetJobByName

Resource Path: /JAMS/APIHelp/docs/V6/api/job/{name}

Uri: http://left/JAMS/APIHelp/docs/V6/api/job/{name}

Description
Get the Job with the specified name.
Parameters
NameDescriptionData Type
nameThe name of the Jobstring
Response

The response body is of type Job.

OK

Overview

Job
acl : ACL
genericACL : Array[ACE]
identifier : string
flags : string
access : string
advanceWarning : string
agentNode : string
alerts : Array[AlertReq]
alertID : integer
alertName : string
isInherited : boolean
autoSubmit : boolean
avgBufferedIOCount : integer
avgCount : integer
avgCpuTime : string
avgDirectIOCount : integer
avgElapsedTime : string
avgPageFaults : integer
avgWorkingSetPeak : integer
badPattern : string
batchQueueID : integer
batchQueueName : string
defaultDate : string
defaultSubmitTime : string
dependencies : Array[Dependency]
dependencyName : string
dependencyType : string
dependID : integer
description : string
lastChangeUTC : string
description : string
exceptForDate : string
goodPattern : string
homeDirectory : string
jobID : integer
jobName : string
keepLogs : string
lastAutosubmitUTC : string
lastChangedBy : string
lastChangeUTC : string
lastErrorUTC : string
lastFatalUTC : string
lastInfoUTC : string
lastResetUTC : string
lastSuccessUTC : string
lastWarningUTC : string
logFilename : string
maxBufferedIOCount : integer
maxCount : integer
maxCpuTime : string
maxDirectIOCount : integer
maxElapsedTime : string
maxPageFaults : integer
maxWorkingSetPeak : integer
minBufferedIOCount : integer
minCount : integer
minCpuTime : string
minDirectIOCount : integer
minElapsedTime : string
minPageFaults : integer
minWorkingSetPeak : integer
missedWindowAction : string
nonWorkdayScheduling : string
notifyEMail : string
notifyJobID : integer
notifyJobName : string
notifyJobNameIsRelative : boolean
notifyOfMissedWindow : boolean
notifyOther : string
notifySeverity : string
notifyUser : boolean
notifyUsers : string
parameters : Array[Param]
allowEntry : boolean
dataType : string
defaultFormat : string
defaultValue : string
helpText : string
hide : boolean
jobID : integer
lastChangeUTC : string
length : integer
mustFill : boolean
parameterOrigin : string
paramName : string
prompt : string
required : boolean
sequence : integer
uppercase : boolean
validationData : string
validationType : string
variableID : integer
variableName : string
variableNameIsRelative : boolean
parentFolderID : integer
parentFolderName : string
precheckInterval : string
precheckJobID : integer
precheckJobName : string
precheckJobNameIsRelative : boolean
recoverJobID : integer
recoverJobName : string
recoverJobNameIsRelative : boolean
recoveryInstructions : string
recoverySeverity : string
reports : Array[Report]
copies : integer
description : string
fullFilename : string
lastChangeUTC : string
logicalName : string
printForm : string
printQualifiers : string
printQueue : string
reportID : string
retentionDays : integer
requirements : Array[ResReq]
autoRelease : boolean
lastChangeUTC : string
netQuantityRequired : integer
quantityInherited : integer
quantityRequired : integer
resourceID : integer
resourceName : string
retainOnFailure : boolean
restartable : boolean
resubmitBase : string
resubmitDelay : string
resubmitEnd : string
resubmitOnError : boolean
retainOption : string
retainTime : string
retryCount : integer
retryInterval : string
runawayAction : string
runawayElapsed : string
runawayElapsedPer : integer
runPriority : integer
scheduledDate : string
scheduledDateEnd : string
scheduledDateStart : string
scheduledTime : string
scheduleFromTime : string
scheduleToTime : string
scheduleWindowID : integer
scheduleWindowName : string
schedulingPriorityModifier : integer
shortElapsed : string
shortElapsedPer : integer
shortSeverity : string
slaTime : string
source : string
specificInformational : string
specificValues : string
specificWarning : string
stalledTime : string
submitMethodID : integer
submitMethodName : string
submitOnHold : boolean
suppressMenuDisplay : boolean
timestampLogs : string
timeZoneID : integer
timeZoneName : string
userID : integer
userName : string
workingSetDefault : integer
workingSetMax : integer
workingSetQuota : integer
See Also
All Operations Resource GroupJAMS REST API Web Service

 

 


© 2017 All Rights Reserved.

Send comments on this topic.